<html>
<head><meta charset="utf-8"><title>docs · t-compiler/rust-analyzer · Zulip Chat Archive</title></head>
<h2>Stream: <a href="https://rust-lang.github.io/zulip_archive/stream/185405-t-compiler/rust-analyzer/index.html">t-compiler/rust-analyzer</a></h2>
<h3>Topic: <a href="https://rust-lang.github.io/zulip_archive/stream/185405-t-compiler/rust-analyzer/topic/docs.html">docs</a></h3>

<hr>

<base href="https://rust-lang.zulipchat.com">

<head><link href="https://rust-lang.github.io/zulip_archive/style.css" rel="stylesheet"></head>

<a name="187848851"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/185405-t-compiler/rust-analyzer/topic/docs/near/187848851" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> divma <a href="https://rust-lang.github.io/zulip_archive/stream/185405-t-compiler/rust-analyzer/topic/docs.html#187848851">(Feb 10 2020 at 19:19)</a>:</h4>
<p>Hi, recently I worked (more like.. _still working on_) an issue in rust_analyzer, and I think it is not that far from landing, but the process would have been easier with a bit more of docs. There are <em>lots</em> of thing I need to use to solve what I'm working on but that I simply can't just figure out what's their intended meaning/usage/etc. Is there any plan on expanding docs coverage? I would love to help in writing such docs simply because doing so would allow me to understand the code base, and then of course, it would help other new-to-ra developers willing to do stuff. Of course, this would need to be made with a good amount of guidance. Thought?</p>



<a name="187849145"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/185405-t-compiler/rust-analyzer/topic/docs/near/187849145" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Jeremy Kolb <a href="https://rust-lang.github.io/zulip_archive/stream/185405-t-compiler/rust-analyzer/topic/docs.html#187849145">(Feb 10 2020 at 19:22)</a>:</h4>
<p>PRs welcome!</p>



<a name="187854040"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/185405-t-compiler/rust-analyzer/topic/docs/near/187854040" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> matklad <a href="https://rust-lang.github.io/zulip_archive/stream/185405-t-compiler/rust-analyzer/topic/docs.html#187854040">(Feb 10 2020 at 20:19)</a>:</h4>
<p>In general, we are pretty bad with docs. </p>
<p>THe geneneral idea is to maintain module-level docs and the top-level achitecture.md</p>



<a name="187854053"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/185405-t-compiler/rust-analyzer/topic/docs/near/187854053" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> matklad <a href="https://rust-lang.github.io/zulip_archive/stream/185405-t-compiler/rust-analyzer/topic/docs.html#187854053">(Feb 10 2020 at 20:19)</a>:</h4>
<p>Function level docs unfortunatelly usually get obsoleted pretty quickly :(</p>



<a name="187854080"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/185405-t-compiler/rust-analyzer/topic/docs/near/187854080" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> matklad <a href="https://rust-lang.github.io/zulip_archive/stream/185405-t-compiler/rust-analyzer/topic/docs.html#187854080">(Feb 10 2020 at 20:19)</a>:</h4>
<p>In general, it's a good idea to send a PR with docs if it took you some time to understand smth</p>



<a name="187861174"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/185405-t-compiler/rust-analyzer/topic/docs/near/187861174" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> divma <a href="https://rust-lang.github.io/zulip_archive/stream/185405-t-compiler/rust-analyzer/topic/docs.html#187861174">(Feb 10 2020 at 21:38)</a>:</h4>
<p>that's a bit sad to hear, but good to know. I still think there is "improvement opportunity " wrt to documenting concepts that seem to appear in various places  and that would benefit from a small doc comment. That being said, i'll send a PR whenever I find  places in which that's the case</p>



<hr><p>Last updated: Aug 07 2021 at 22:04 UTC</p>
</html>